
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta charset="utf-8"></meta>
		<meta name="generator" content="JsDoc Toolkit"></meta>
		<title>helma.Mail | Antville&#32;1.4&#32;API&#32;Reference</title>

		<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
		<meta name="mobileoptimized" content="0"></meta>
	
		<link rel="stylesheet" href="../css/all.css" media="all"></link>
		<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
		<link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
		<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>

		<script src="../javascript/all.js"></script>
		<!--[if lt IE 9]>
			<script src="../javascript/html5.js"></script>
		<![endif]-->
	</head>

	<body>

<div class="index">
	<div class="menu">
		<div class="indexLinks">
			<a href="../index.html">Classes</a>
			<a href="../files.html">Files</a>
		</div>
	
		<h2 class="heading1">Classes</h2>
		
		<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
		
		<nav>
			<ul class="classList" id="ClassList">
				
					<li><a href="../symbols/_global_.html">_global_</a></li>
				
					<li><a href="../symbols/Admin.html">Admin</a></li>
				
					<li><a href="../symbols/Admin.Job.html">Admin<span class='break'> </span>.<span class='break'> </span>Job</a></li>
				
					<li><a href="../symbols/Api.html">Api</a></li>
				
					<li><a href="../symbols/Api.blogger.html">Api<span class='break'> </span>.<span class='break'> </span>blogger</a></li>
				
					<li><a href="../symbols/Api.metaWeblog.html">Api<span class='break'> </span>.<span class='break'> </span>metaWeblog</a></li>
				
					<li><a href="../symbols/Api.mt.html">Api<span class='break'> </span>.<span class='break'> </span>mt</a></li>
				
					<li><a href="../symbols/app.data.html">app<span class='break'> </span>.<span class='break'> </span>data</a></li>
				
					<li><a href="../symbols/Archive.html">Archive</a></li>
				
					<li><a href="../symbols/Choice.html">Choice</a></li>
				
					<li><a href="../symbols/Comment.html">Comment</a></li>
				
					<li><a href="../symbols/console.html">console</a></li>
				
					<li><a href="../symbols/Exporter.html">Exporter</a></li>
				
					<li><a href="../symbols/Feature.html">Feature</a></li>
				
					<li><a href="../symbols/File.html">File</a></li>
				
					<li><a href="../symbols/Files.html">Files</a></li>
				
					<li><a href="../symbols/helma.File.html">helma<span class='break'> </span>.<span class='break'> </span>File</a></li>
				
					<li><a href="../symbols/helma.Mail.html">helma<span class='break'> </span>.<span class='break'> </span>Mail</a></li>
				
					<li><a href="../symbols/HopObject.html">HopObject</a></li>
				
					<li><a href="../symbols/Image.html">Image</a></li>
				
					<li><a href="../symbols/Images.html">Images</a></li>
				
					<li><a href="../symbols/Images.Default.html">Images<span class='break'> </span>.<span class='break'> </span>Default</a></li>
				
					<li><a href="../symbols/Importer.html">Importer</a></li>
				
					<li><a href="../symbols/jala.i18n.html">jala<span class='break'> </span>.<span class='break'> </span>i18n</a></li>
				
					<li><a href="../symbols/JSON.html">JSON</a></li>
				
					<li><a href="../symbols/Layout.html">Layout</a></li>
				
					<li><a href="../symbols/LogEntry.html">LogEntry</a></li>
				
					<li><a href="../symbols/Members.html">Members</a></li>
				
					<li><a href="../symbols/Membership.html">Membership</a></li>
				
					<li><a href="../symbols/Metadata.html">Metadata</a></li>
				
					<li><a href="../symbols/Poll.html">Poll</a></li>
				
					<li><a href="../symbols/Polls.html">Polls</a></li>
				
					<li><a href="../symbols/Root.html">Root</a></li>
				
					<li><a href="../symbols/Site.html">Site</a></li>
				
					<li><a href="../symbols/Skin.html">Skin</a></li>
				
					<li><a href="../symbols/Skins.html">Skins</a></li>
				
					<li><a href="../symbols/Sql.html">Sql</a></li>
				
					<li><a href="../symbols/Stories.html">Stories</a></li>
				
					<li><a href="../symbols/Story.html">Story</a></li>
				
					<li><a href="../symbols/Tag.html">Tag</a></li>
				
					<li><a href="../symbols/TagHub.html">TagHub</a></li>
				
					<li><a href="../symbols/Tags.html">Tags</a></li>
				
					<li><a href="../symbols/User.html">User</a></li>
				
					<li><a href="../symbols/Vote.html">Vote</a></li>
				
			</ul>
		</nav>
	</div>
	<div class="fineprint" style="clear:both">
		
		Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
		Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
		Generated on: 2012-4-22 10:17
	</div>
</div>

<div class="index indexStatic"></div>

<div class="content">
	<div class="innerContent">
		<h1 class="classTitle">
			
			Namespace <span>helma.Mail</span>
		</h1>
		
		<div class="intro">
			<p class="description summary">
				
			</p>
				
			
				<ul class="summary">
					
					
					
						<li>Defined in: <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a></li>
					
						
				</ul>
			
		</div>
		
		
			<div class="props">
				<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class helma.Mail.">
					<caption class="sectionTitle">Namespace Summary</caption>
					<thead>
						<tr>
							<th scope="col">Constructor Attributes</th>
							<th scope="col">Constructor Name and Description</th>
						</tr>
					</thead>
					<tbody>
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription" >
								<div class="fixedFont">
									<b><a href="../symbols/helma.Mail.html#constructor">helma.Mail</a></b>
								</div>
								<div class="description">The helma.Mail prototype is defined in a module.</div>
							</td>
						</tr>
					</tbody>
				</table>
			</div>
		
		
		
<!--
#### METHODS SUMMARY
-->
		
			
			
			<div class="props">
				<h2 class="sectionTitle">Method Summary</h2>
				
				
					<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class helma.Mail.">
						<thead>
							<tr>
								<th scope="col">Method Attributes</th>
								<th scope="col">Method Name and Description</th>
							</tr>
						</thead>
						
						<tbody>
							
							
								<tr
									 class='item0'
								>
									<td class="attributes">&lt;static&gt; &nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">helma.Mail.<b><a href="../symbols/helma.Mail.html#.flushQueue">flushQueue</a></b>()
										</div>
										<div class="description">Try to send and remove every mail instance collected in the mail queue.</div>
									</td>
								</tr>
							
								<tr
									 class='item1'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/helma.Mail.html#queue">queue</a></b>()
										</div>
										<div class="description">Add an e-mail message to the mail queue for later sending.</div>
									</td>
								</tr>
							
						</tbody>
					</table>
				
			
				
			</div>
		
		
<!--
#### EVENTS SUMMARY
-->
		
<!--
#### CONSTRUCTOR DETAILS
-->
		
			<div class="details props">
				<div class="innerProps">
					<h2 class="sectionTitle" id="constructor">
						Namespace Detail
					</h2>
					
					<div class="fixedFont">
						<b>helma.Mail</b>
					</div>
					
					<div class="description">
						The helma.Mail prototype is defined in a module.
						
					</div>
					
					
				
					
					
					
				</div>
			</div>
		
<!--
#### FIELD DETAILS
-->
		
<!--
#### METHOD DETAILS
-->		
		
			<div class="details props">
				<div class="innerProps">
					<h2 class="sectionTitle">
						Method Detail
					</h2>
					
					<ul class="methodDetail" id="MethodDetail">
						
						
							<li 
								 class='item0'
							>
								<div class="fixedFont heading" id=".flushQueue">
									<span class='lighter'>
									&lt;static&gt; 
									</span>
									
									
									
									<span class="light">helma.Mail.</span><b>flushQueue</b>()
								</div>
								
								<div class="description">
									Try to send and remove every mail instance collected in the mail queue.
									
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/app.data.html#.mails">app.data.mails</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item1'
							>
								<div class="fixedFont heading" id="queue">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Number}</span>
									
									<b>queue</b>()
								</div>
								
								<div class="description">
									Add an e-mail message to the mail queue for later sending.
									
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Number}</span> The number of mails waiting in the queue</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/app.data.html#.mails">app.data.mails</a></dd>
											
										
									
									</dl>
								
								
							</li>
						
					</ul>
				</div>
			</div>
		
		
<!--
#### EVENT DETAILS
-->		
		
	</div>
</div>
		<script type="text/javascript">
			wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
			codeview.classFilter.Init()
		</script>
	</body>
</html>

